Create Policy

cURL

curl --request POST \
  --url 'https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Fast Movers - Forward Pick","is_active":false,"sort_order":10,"merchant_ids":[2,7],"product_profile_ids":[12,15],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":3,"demand_period_days":30,"trigger_doi_days":7,"target_doi_days":21}'

import json
import requests

url = "https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count"
headers = {"Authorization": "Bearer <token>"}
payload = json.loads('{"name":"Fast Movers - Forward Pick","is_active":false,"sort_order":10,"merchant_ids":[2,7],"product_profile_ids":[12,15],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":3,"demand_period_days":30,"trigger_doi_days":7,"target_doi_days":21}')

response = requests.request('POST', url, headers=headers, json=payload)
print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({"name":"Fast Movers - Forward Pick","is_active":false,"sort_order":10,"merchant_ids":[2,7],"product_profile_ids":[12,15],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":3,"demand_period_days":30,"trigger_doi_days":7,"target_doi_days":21}),
};

fetch('https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count', options)
  .then(response => response.json())
  .then(response => console.log(response));

<?php

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count',
    CURLOPT_RETURNTRANSFER => TRUE,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"name":"Fast Movers - Forward Pick","is_active":false,"sort_order":10,"merchant_ids":[2,7],"product_profile_ids":[12,15],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":3,"demand_period_days":30,"trigger_doi_days":7,"target_doi_days":21}',
    CURLOPT_HTTPHEADER => ['Authorization: Bearer <token>', 'Content-Type: application/json'],
]);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
    "strings"
)

func main() {
    request, _ := http.NewRequest("POST", "https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count", strings.NewReader(`{"name":"Fast Movers - Forward Pick","is_active":false,"sort_order":10,"merchant_ids":[2,7],"product_profile_ids":[12,15],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":3,"demand_period_days":30,"trigger_doi_days":7,"target_doi_days":21}`))
    request.Header.Add("Authorization", "Bearer <token>")
    request.Header.Add("Content-Type", "application/json")
    response, _ := http.DefaultClient.Do(request)
    defer response.Body.Close()
    body, _ := io.ReadAll(response.Body)
    fmt.Println(string(body))
}

HttpResponse<String> response = Unirest.post("https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\"name\":\"Fast Movers - Forward Pick\",\"is_active\":false,\"sort_order\":10,\"merchant_ids\":[2,7],\"product_profile_ids\":[12,15],\"product_profile_match_mode\":\"any\",\"handling_class_ids\":[4],\"location_profile_id\":3,\"demand_period_days\":30,\"trigger_doi_days\":7,\"target_doi_days\":21}")
  .asString();

require 'uri'
require 'net/http'

url = URI('https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count')
request = Net::HTTP::Post.new(url)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = '{"name":"Fast Movers - Forward Pick","is_active":false,"sort_order":10,"merchant_ids":[2,7],"product_profile_ids":[12,15],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":3,"demand_period_days":30,"trigger_doi_days":7,"target_doi_days":21}'

response = Net::HTTP.start(url.hostname, url.port, use_ssl: true) do |http|
  http.request(request)
end
puts response.read_body

{
  "resource": {
    "type": "ReplenishmentPolicy",
    "id": 7,
    "name": "Fast Movers - Forward Pick",
    "is_active": false,
    "sort_order": 0,
    "merchant_ids": [
      2,
      7
    ],
    "product_profile_ids": [
      12,
      15
    ],
    "product_profile_match_mode": "any",
    "handling_class_ids": [
      4
    ],
    "merchants": [
      {
        "type": "Merchant",
        "id": 2
      },
      {
        "type": "Merchant",
        "id": 7
      }
    ],
    "product_profiles": [
      {
        "type": "ProductProfile",
        "id": 12
      },
      {
        "type": "ProductProfile",
        "id": 15
      }
    ],
    "handling_classes": [
      {
        "type": "HandlingClass",
        "id": 4
      }
    ],
    "location_profile": {
      "type": "LocationProfile",
      "id": 3
    },
    "demand_period_days": 30,
    "trigger_doi_days": 7,
    "target_doi_days": 21,
    "qualification_reason": "inactive",
    "created_at": "2026-08-12T11:30:00Z",
    "updated_at": "2026-08-12T11:30:00Z"
  },
  "included": {
    "Merchant": [
      {
        "type": "Merchant",
        "id": 2,
        "code": "retail_direct",
        "name": "Retail Direct",
        "status": "active"
      },
      {
        "type": "Merchant",
        "id": 7,
        "code": "marketplace",
        "name": "Marketplace",
        "status": "active"
      }
    ],
    "ProductProfile": [
      {
        "type": "ProductProfile",
        "id": 12,
        "name": "Regulated Aerosols",
        "code": "regulated_aerosols"
      },
      {
        "type": "ProductProfile",
        "id": 15,
        "name": "Fast Movers",
        "code": "fast_movers"
      }
    ],
    "HandlingClass": [
      {
        "type": "HandlingClass",
        "id": 4,
        "name": "Hazmat",
        "code": "hazmat"
      }
    ],
    "LocationProfile": [
      {
        "type": "LocationProfile",
        "id": 3,
        "name": "Pick Face",
        "status": "ready",
        "member_count": 1275
      }
    ]
  },
  "meta": {
    "processing_time": 0.0114
  }
}

{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid."
    }
  ]
}

{
  "errors": [
    {
      "type": "not_found",
      "message": "The server could not find the requested resource."
    }
  ]
}

{
  "errors": [
    {
      "type": "unable_to_process",
      "message": "There was an error processing the request."
    }
  ]
}

POST

inventory

warehouses

{id}

replenishment-policies

cURL

curl --request POST \
  --url 'https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Fast Movers - Forward Pick","is_active":false,"sort_order":10,"merchant_ids":[2,7],"product_profile_ids":[12,15],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":3,"demand_period_days":30,"trigger_doi_days":7,"target_doi_days":21}'

import json
import requests

url = "https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count"
headers = {"Authorization": "Bearer <token>"}
payload = json.loads('{"name":"Fast Movers - Forward Pick","is_active":false,"sort_order":10,"merchant_ids":[2,7],"product_profile_ids":[12,15],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":3,"demand_period_days":30,"trigger_doi_days":7,"target_doi_days":21}')

response = requests.request('POST', url, headers=headers, json=payload)
print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({"name":"Fast Movers - Forward Pick","is_active":false,"sort_order":10,"merchant_ids":[2,7],"product_profile_ids":[12,15],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":3,"demand_period_days":30,"trigger_doi_days":7,"target_doi_days":21}),
};

fetch('https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count', options)
  .then(response => response.json())
  .then(response => console.log(response));

<?php

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count',
    CURLOPT_RETURNTRANSFER => TRUE,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"name":"Fast Movers - Forward Pick","is_active":false,"sort_order":10,"merchant_ids":[2,7],"product_profile_ids":[12,15],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":3,"demand_period_days":30,"trigger_doi_days":7,"target_doi_days":21}',
    CURLOPT_HTTPHEADER => ['Authorization: Bearer <token>', 'Content-Type: application/json'],
]);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
    "strings"
)

func main() {
    request, _ := http.NewRequest("POST", "https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count", strings.NewReader(`{"name":"Fast Movers - Forward Pick","is_active":false,"sort_order":10,"merchant_ids":[2,7],"product_profile_ids":[12,15],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":3,"demand_period_days":30,"trigger_doi_days":7,"target_doi_days":21}`))
    request.Header.Add("Authorization", "Bearer <token>")
    request.Header.Add("Content-Type", "application/json")
    response, _ := http.DefaultClient.Do(request)
    defer response.Body.Close()
    body, _ := io.ReadAll(response.Body)
    fmt.Println(string(body))
}

HttpResponse<String> response = Unirest.post("https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\"name\":\"Fast Movers - Forward Pick\",\"is_active\":false,\"sort_order\":10,\"merchant_ids\":[2,7],\"product_profile_ids\":[12,15],\"product_profile_match_mode\":\"any\",\"handling_class_ids\":[4],\"location_profile_id\":3,\"demand_period_days\":30,\"trigger_doi_days\":7,\"target_doi_days\":21}")
  .asString();

require 'uri'
require 'net/http'

url = URI('https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count')
request = Net::HTTP::Post.new(url)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = '{"name":"Fast Movers - Forward Pick","is_active":false,"sort_order":10,"merchant_ids":[2,7],"product_profile_ids":[12,15],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":3,"demand_period_days":30,"trigger_doi_days":7,"target_doi_days":21}'

response = Net::HTTP.start(url.hostname, url.port, use_ssl: true) do |http|
  http.request(request)
end
puts response.read_body

{
  "resource": {
    "type": "ReplenishmentPolicy",
    "id": 7,
    "name": "Fast Movers - Forward Pick",
    "is_active": false,
    "sort_order": 0,
    "merchant_ids": [
      2,
      7
    ],
    "product_profile_ids": [
      12,
      15
    ],
    "product_profile_match_mode": "any",
    "handling_class_ids": [
      4
    ],
    "merchants": [
      {
        "type": "Merchant",
        "id": 2
      },
      {
        "type": "Merchant",
        "id": 7
      }
    ],
    "product_profiles": [
      {
        "type": "ProductProfile",
        "id": 12
      },
      {
        "type": "ProductProfile",
        "id": 15
      }
    ],
    "handling_classes": [
      {
        "type": "HandlingClass",
        "id": 4
      }
    ],
    "location_profile": {
      "type": "LocationProfile",
      "id": 3
    },
    "demand_period_days": 30,
    "trigger_doi_days": 7,
    "target_doi_days": 21,
    "qualification_reason": "inactive",
    "created_at": "2026-08-12T11:30:00Z",
    "updated_at": "2026-08-12T11:30:00Z"
  },
  "included": {
    "Merchant": [
      {
        "type": "Merchant",
        "id": 2,
        "code": "retail_direct",
        "name": "Retail Direct",
        "status": "active"
      },
      {
        "type": "Merchant",
        "id": 7,
        "code": "marketplace",
        "name": "Marketplace",
        "status": "active"
      }
    ],
    "ProductProfile": [
      {
        "type": "ProductProfile",
        "id": 12,
        "name": "Regulated Aerosols",
        "code": "regulated_aerosols"
      },
      {
        "type": "ProductProfile",
        "id": 15,
        "name": "Fast Movers",
        "code": "fast_movers"
      }
    ],
    "HandlingClass": [
      {
        "type": "HandlingClass",
        "id": 4,
        "name": "Hazmat",
        "code": "hazmat"
      }
    ],
    "LocationProfile": [
      {
        "type": "LocationProfile",
        "id": 3,
        "name": "Pick Face",
        "status": "ready",
        "member_count": 1275
      }
    ]
  },
  "meta": {
    "processing_time": 0.0114
  }
}

{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid."
    }
  ]
}

{
  "errors": [
    {
      "type": "not_found",
      "message": "The server could not find the requested resource."
    }
  ]
}

{
  "errors": [
    {
      "type": "unable_to_process",
      "message": "There was an error processing the request."
    }
  ]
}

Authorizations

Authorization

string

header

required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

integer<int32>

required

The id of the referenced Warehouse.

Query Parameters

fields

enum<string>[]

Specify additional fields of the ReplenishmentPolicy object to be included in the response.

Available options:

basic,

all,

name,

is_active,

sort_order,

merchant_ids,

merchants,

product_profile_ids,

product_profiles,

product_profile_match_mode,

handling_class_ids,

handling_classes,

subject_readable,

location_profile,

demand_period_days,

trigger_doi_days,

target_doi_days,

qualification_reason,

flagged_sku_count,

skipped_sku_count,

slotting_forbidden_count,

results_refresh_pending,

created_at,

updated_at

fields:merchants

enum<string>[]

Specify direct fields of selected Merchant objects to include under included.Merchant. Add merchants to the root fields parameter to return the relationship. type and id are always returned. Specify direct fields of an included Merchant object.

Available options:

code,

name,

status,

created_at,

updated_at

fields:product_profiles

enum<string>[]

Specify fields of selected ProductProfile objects to include under included.ProductProfile. Add product_profiles to the root fields parameter to return the relationship. type and id are always returned. Specify fields of an included ProductProfile object.

Available options:

basic,

all,

name,

code,

conditions,

conditions_readable,

matched_count,

classification,

created_at,

updated_at

fields:handling_classes

enum<string>[]

Specify direct fields of selected HandlingClass objects to include under included.HandlingClass. Add handling_classes to the root fields parameter to return the relationship. type and id are always returned. Specify direct fields of an included HandlingClass object.

Available options:

name,

code,

sort_order,

conditions,

conditions_readable,

matched_count,

classification,

created_at,

updated_at

fields:location_profile

enum<string>[]

Specify direct fields of the LocationProfile selected by each Policy. Location Tags and Slot Types remain available from the Profile's own endpoint. Specify direct fields of the included LocationProfile object.

Available options:

name,

description,

status,

member_count,

match,

match_readable,

active_revision,

pending_revision,

used_by,

created_at,

updated_at

Body

application/json

The configuration of a new Replenishment Policy. The warehouse comes from the path, and every derived or index-owned property of ReplenishmentPolicy is rejected if present.

name

string

required

The user-visible Policy name; must be unique within the warehouse.

Required string length: 1 - 255

Example:

"Fast Movers - Forward Pick"

location_profile_id

integer<int32>

required

The id of the Location Profile supplying the target group. It must belong to this warehouse and already have a published revision.

Required range: x >= 1

Example:

3

demand_period_days

integer

required

The Product Velocity window used to derive daily demand. Must equal one of the configured Product Velocity periods.

Required range: 1 <= x <= 65535

Example:

30

trigger_doi_days

number

required

The coverage threshold below which an assigned Product is flagged for Replenishment.

Required range: 0 <= x <= 999999.9999

Example:

7

target_doi_days

number

required

The target coverage used to calculate the required replenishment quantity. Must not be lower than trigger_doi_days; equal values are accepted.

Required range: 0 <= x <= 999999.9999

Example:

21

is_active

boolean

default:false

Whether the Policy participates in Product evaluation. Omitted, a Policy is created inactive and no Replenishment rebuild is requested.

sort_order

integer

default:0

Policy precedence; lower values are evaluated first, with id as the tie-break.

Required range: 0 <= x <= 65535

Example:

10

merchant_ids

integer[] | null

Merchant IDs the Policy selects. null or an empty list means every Merchant.

Maximum array length: 100

Required range: x >= 1

Example:

[2, 7]

product_profile_ids

integer[]

Product Profile IDs the Policy selects. An empty list means Product Profiles do not restrict the subject.

Maximum array length: 100

Required range: x >= 1

Example:

[12, 15]

product_profile_match_mode

enum<string>

default:any

How the selected Product Profiles are matched against a Product. The none mode requires at least one Product Profile.

Available options:

any,

all,

none

handling_class_ids

integer[]

Handling Class IDs the Policy selects. Each must be assigned to this warehouse. An empty list means Handling Classes do not restrict the subject.

Maximum array length: 100

Required range: x >= 1

Example:

[4]

Response

The Replenishment Policy was created successfully.

resource

ReplenishmentPolicy · object

A Replenishment Policy configuration for one warehouse. The Policy selects Products by Merchant, Product Profile, and Handling Class, then applies Trigger and Target days-of-inventory thresholds to one Location Profile.

Show child attributes

Example:

{
  "type": "ReplenishmentPolicy",
  "id": 7,
  "name": "Fast Movers - Forward Pick",
  "is_active": true,
  "sort_order": 10,
  "merchant_ids": [2, 7],
  "product_profile_ids": [12, 15],
  "product_profile_match_mode": "any",
  "handling_class_ids": [4],
  "location_profile": { "type": "LocationProfile", "id": 3 },
  "demand_period_days": 30,
  "trigger_doi_days": 7,
  "target_doi_days": 21,
  "qualification_reason": null,
  "created_at": "2026-08-01T09:30:00Z",
  "updated_at": "2026-08-12T10:15:00Z"
}

included

object

Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.

Show child attributes

Example:

{}

Get Started

Common Features

Inventory API v1

Receiving API v1

Shipping API v1

System API v1

Authorizations

Path Parameters

Query Parameters

Body

Response